/*
 * CCVisu is a tool for visual graph clustering
 * and general force-directed graph layout.
 * This file is part of CCVisu.
 *
 * Copyright (C) 2005-2011  Dirk Beyer
 *
 * CCVisu is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * CCVisu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with CCVisu; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please find the GNU Lesser General Public License in file
 * license_lgpl.txt or http://www.gnu.org/licenses/lgpl.txt
 *
 * Dirk Beyer    (firstname.lastname@uni-passau.de)
 * University of Passau, Bavaria, Germany
 */
package org.sosy_lab.ccvisu.writers;

import java.io.PrintWriter;

import org.sosy_lab.ccvisu.CCVisuController;
import org.sosy_lab.ccvisu.graph.GraphData;
import org.sosy_lab.common.configuration.InvalidConfigurationException;

/**
 * Writer for output data.
 */
public abstract class WriterData implements Writer {

  /** End of line.*/
  protected final static String endl = CCVisuController.endl;

  /** Output stream. */
  protected PrintWriter         out;

  /** Graph representation. */
  protected GraphData              graph;

  /**
   * Constructor.
   * @param graph  Graph representation.
   * @throws InvalidConfigurationException
   */
  public WriterData(PrintWriter out, GraphData graph) {
    assert(out != null && graph != null);

    this.out = out;
    this.graph = graph;
  }

  /**
   * Writes the graph or layout data.
   */
  @Override
  public abstract void write();

  /**
   * If pElem contains a whitespace character, then return it with quotes around.
   */
  protected String mkConnected(String element) {
    if (element.matches(".*\\s.*")) {
      return '"' + element + '"';
    }

    return element;
  }
}
